<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class ActionMessage</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class ActionMessage</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ActionMessage class</p>
		<p class="notes">
			Located in <a class="field" href="_mvc---action---ActionMessage.php.html">/mvc/action/ActionMessage.php</a> (line <span class="field">36</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<img src="../../media/images/Constant.png" alt=" " />
					<a href="#GLOBAL_MESSAGE" title="details" class="const-name">GLOBAL_MESSAGE</a> = 					<span class="var-type"> &quot;nl.melange.phpmvc.action.GLOBAL_MESSAGE&quot;</span>

				</div>
							</div>
		</div>
	</div>

	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="var-summary">
																																								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$key" title="details" class="var-name">$key</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$resource" title="details" class="var-name">$resource</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$values" title="details" class="var-name">$values</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																												
												<div class="method-definition">
											<span class="method-result">ActionMessage</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">key</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">values</span>&nbsp;<span class="var-name">$resource</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$values</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">The</span>
										<a href="#getKey" title="details" class="method-name">getKey</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">The</span>
										<a href="#getValues" title="details" class="method-name">getValues</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result"><code>true</code></span>
										<a href="#isResource" title="details" class="method-name">isResource</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">String</span>
										<a href="#__toString" title="details" class="method-name">__toString</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$key" id="$key"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$key</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">51</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;The message key for this message.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$resource" id="$resource"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$resource</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">64</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Indicates whether the key is taken to be as a  bundle key [true] or</p>
<p class="description"><p>literal value [false].&lt;/p&gt;</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$values" id="$values"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$values</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">57</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;The replacement values for this mesasge.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																			<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">77</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Construct an action message with the specified replacement  values.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">ActionMessage</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">key</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">values</span>&nbsp;<span class="var-name">$resource</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$values</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">key</span>
				<span class="var-name">$key</span><span class="var-description">: Message key for this message</span>			</li>
					<li>
				<span class="var-type">values</span>
				<span class="var-name">$resource</span><span class="var-description">: Array of replacement values</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$values</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetKey" id="getKey"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getKey</span> (line <span class="line-number">92</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Get the message key for this message.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> message key for this message.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			getKey
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetValues" id="getValues"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getValues</span> (line <span class="line-number">102</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Get the replacement values for this message.&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> replacement values for this message.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">The</span>
		<span class="method-name">
			getValues
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisResource" id="isResource"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">isResource</span> (line <span class="line-number">114</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Indicate whether the key is taken to be as a  bundle key [true] or  literal value [false].&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> if the key is a bundle key;          <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> otherwise.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><code>true</code></span>
		<span class="method-name">
			isResource
		</span>
				()
			</div>
	
		
			
	</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">__toString</span> (line <span class="line-number">125</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">&lt;p&gt;Returns a String in the format: key[value1, value2, etc].&lt;/p&gt;</p>
	<ul class="tags">
				<li><span class="field">return:</span> representation of this message</li>
				<li><span class="field">see:</span> toString()</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">String</span>
		<span class="method-name">
			__toString
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constGLOBAL_MESSAGE" id="GLOBAL_MESSAGE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">GLOBAL_MESSAGE</span>
			 = <span class="const-default"> &quot;nl.melange.phpmvc.action.GLOBAL_MESSAGE&quot;</span>
			(line <span class="line-number">42</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Fri, 08 Feb 2008 14:32:33 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>